home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Vk / VkOptionMenu.z / VkOptionMenu
Encoding:
Text File  |  1998-10-20  |  9.6 KB  |  265 lines

  1.  
  2.  
  3.  
  4. VVVVkkkkOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333xxxx))))                                              VVVVkkkkOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkOptionMenu - An option menu for use with ViewKit menu items
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkMenu : VkMenuItem : VkComponent : VkCallbackObject
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <Vk/VkOptionMenu.h>
  16.  
  17. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  18.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  19.            VkOptionMenu(VkMenuDesc *desc,
  20.                         XtPointer   defaultClientData = NULL);
  21.  
  22.            VkOptionMenu(const char *name = "optionMenu",
  23.                         VkMenuDesc *desc = NULL,
  24.                         XtPointer   defaultClientData = NULL);
  25.  
  26.            VkOptionMenu(Widget      parent,
  27.                         VkMenuDesc *desc,
  28.                         XtPointer   defaultClientData = NULL);
  29.  
  30.            VkOptionMenu(Widget      parent,
  31.                         const char *name = "optionMenu",
  32.                         VkMenuDesc *desc = NULL,
  33.                         XtPointer   defaultClientData = NULL);
  34.  
  35.            ~VkOptionMenu();
  36.  
  37.  
  38.    BBBBuuuuiiiillllddddiiiinnnngggg MMMMeeeennnnuuuussss
  39.            virtual void  build()
  40.  
  41.  
  42.    SSSSeeeelllleeeeccccttttiiiinnnngggg IIIItttteeeemmmmssss
  43.            void set(char* name);
  44.            void set(int index);
  45.            void set(VkMenuItem* item);
  46.  
  47.  
  48.    DDDDeeeetttteeeerrrrmmmmiiiinnnniiiinnnngggg SSSSeeeelllleeeecccctttteeeedddd IIIItttteeeemmmmssss
  49.            int getIndex();
  50.            VkMenuItem *getItem();
  51.  
  52.  
  53.  
  54.    SSSSeeeettttttttiiiinnnngggg ssssiiiizzzzeeeessss
  55.            void forceWidth(int width);
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333xxxx))))                                              VVVVkkkkOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333xxxx))))
  71.  
  72.  
  73.  
  74.    AAAAcccccccceeeessssssss FFFFuuuunnnnccccttttiiiioooonnnnssss
  75.            virtual const char* className();
  76.            virtual VkMenuItemType menuType();
  77.  
  78.  
  79. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  80.    DDDDeeeerrrriiiivvvviiiinnnngggg SSSSuuuubbbbccccllllaaaasssssssseeeessss
  81.    OOOOtttthhhheeeerrrr SSSSeeeeccccttttiiiioooonnnnssss
  82. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  83.    VVVVkkkkOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu
  84.            VkOptionMenu(VkMenuDesc *desc,
  85.                         XtPointer   defaultClientData = NULL);
  86.  
  87.            VkOptionMenu(const char *name = "optionMenu",
  88.                         VkMenuDesc *desc = NULL,
  89.                        XtPointer   defaultClientData = NULL);
  90.  
  91.            VkOptionMenu(Widget      parent,
  92.                         VkMenuDesc *desc,
  93.                         XtPointer   defaultClientData = NULL);
  94.  
  95.            VkOptionMenu(Widget      parent,
  96.                         const char *name = "optionMenu",
  97.                         VkMenuDesc *desc = NULL,
  98.                         XtPointer   defaultClientData = NULL);
  99.  
  100.  
  101.           Initialize an option menu.
  102.  
  103.    ~~~~VVVVkkkkOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu
  104.            ~VkOptionMenu();
  105.  
  106.  
  107.           Cleans up any memory allocated by an option menu.
  108.  
  109.    bbbbuuuuiiiilllldddd
  110.            virtual void  build()
  111.  
  112.  
  113.  
  114.  
  115.    sssseeeetttt
  116.            void set(char*name);
  117.            void set(int index);
  118.            void set(VkMenuItem* item);
  119.  
  120.  
  121.           Set the currently visible menu item in an option menu by name, index
  122.           or a pointer to a VkMenuItem.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333xxxx))))                                              VVVVkkkkOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333xxxx))))
  137.  
  138.  
  139.  
  140.    DDDDeeeetttteeeerrrrmmmmiiiinnnniiiinnnngggg SSSSeeeelllleeeecccctttteeeedddd IIIItttteeeemmmmssss
  141.            int getIndex();
  142.  
  143.  
  144.           Get the index of the currently selected menu item.
  145.  
  146.    ggggeeeettttIIIItttteeeemmmm
  147.            VkMenuItem *getItem();
  148.  
  149.  
  150.           Get the currently selected VkMenuItem menu item.
  151.  
  152.    ffffoooorrrrcccceeeeWWWWiiiiddddtttthhhh
  153.            void forceWidth(int width);
  154.  
  155.  
  156.           Force the width of all items in the option menu to a specific size.
  157.  
  158.    ccccllllaaaassssssssNNNNaaaammmmeeee
  159.            virtual const char* className();
  160.  
  161.  
  162.           Returns "VkOptionMenu".
  163.  
  164.    mmmmeeeennnnuuuuTTTTyyyyppppeeee
  165.             virtual VkMenuItemType menuType ();
  166.  
  167.  
  168.           Returns VkMenuItem::OPTION.
  169.  
  170. EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
  171.               _optionMenu = new VkOptionMenu(parent, "optionMenu");
  172.               _optionMenu->addAction("Red",
  173.                                       &SomeClass::sampleCallback,
  174.                                       (XtPointer) this);
  175.               _optionMenu->addAction("Green",
  176.                                       &SomeClass::sampleCallback,
  177.                                       (XtPointer) this);
  178.               _optionMenu->addAction("Blue",
  179.                                       &SomeClass::sampleCallback,
  180.                                       (XtPointer) this);
  181.               _optionMenu->set("Green");
  182.  
  183.  
  184. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  185.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkMMMMeeeennnnuuuu
  186.           isContainer(), addAction(), addActionWidget(),
  187.           addConfirmFirstAction(), addSeparator(), addLabel(), addToggle(),
  188.           add(), addSubmenu(), addRadioSubmenu(), registerSubmenu(),
  189.           findNamedItem(), removeItem(), activateItem(), deactivateItem(),
  190.           replace(), getItemPosition(), operator[](), numItems(), _contents,
  191.           _nItems, _maxItems
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. VVVVkkkkOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333xxxx))))                                              VVVVkkkkOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333xxxx))))
  203.  
  204.  
  205.  
  206.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkMMMMeeeennnnuuuuIIIItttteeeemmmm
  207.           show(), hide(), manageAll(), setLabel(), setPosition(), activate(),
  208.           deactivate(), remove(), show(), _position, _isBuilt, _sensitive,
  209.           _parentMenu, _label, _isHidden, _unmanagedWidgets,
  210.           _numUnmanagedWidgets
  211.  
  212.  
  213.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
  214.           installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
  215.           setDefaultResources(), getResources(), manage(), unmanage(),
  216.           baseWidget(), okToQuit(), _name, _baseWidget, _w, deleteCallback
  217.  
  218.  
  219.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  220.           callCallbacks(), addCallback(), removeCallback(),
  221.           removeAllCallbacks()
  222.  
  223.  
  224. CCCCLLLLAAAASSSSSSSSEEEESSSS UUUUSSSSEEEEDDDD BBBBYYYY TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  225.      VkMenuItem
  226.  
  227. KKKKNNNNOOOOWWWWNNNN CCCCLLLLAAAASSSSSSSSEEEESSSS TTTTHHHHAAAATTTT UUUUSSSSEEEE TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  228.      VkGraph
  229.  
  230. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  231.      VkMenu, VkMenuItem, VkComponent
  232.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  233.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  234.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  235.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.